pug-code-gen

What is pug-code-gen?

The pug-code-gen package is a part of the Pug templating engine ecosystem. It is responsible for generating JavaScript code from Pug templates. This package is typically used internally by the Pug compiler to convert Pug syntax into executable JavaScript functions.

What are pug-code-gen's main functionalities?

Generate JavaScript Code from Pug Templates

This feature allows you to generate JavaScript code from a Pug template's Abstract Syntax Tree (AST). The generated code can then be executed to render HTML.

const pugCodeGen = require('pug-code-gen');
const ast = { /* Abstract Syntax Tree of a Pug template */ };
const options = { /* options for code generation */ };
const jsCode = pugCodeGen(ast, options);
console.log(jsCode);

Custom Code Generation Options

This feature allows you to customize the code generation process by providing various options such as disabling debug information or formatting the output code to be more readable.

const pugCodeGen = require('pug-code-gen');
const ast = { /* Abstract Syntax Tree of a Pug template */ };
const options = { compileDebug: false, pretty: true };
const jsCode = pugCodeGen(ast, options);
console.log(jsCode);

Other packages similar to pug-code-gen

pug

The 'pug' package is the main package for the Pug templating engine. It includes the full functionality to compile Pug templates into HTML, including parsing, lexing, and code generation. It is more comprehensive compared to pug-code-gen, which focuses solely on the code generation aspect.

ejs

The 'ejs' package is another popular templating engine for JavaScript. It allows you to generate HTML with plain JavaScript. Unlike pug-code-gen, which is part of the Pug ecosystem, EJS uses a different syntax and approach for templating.

handlebars

The 'handlebars' package is a powerful templating engine that provides a more logic-less approach to templates compared to Pug. Handlebars focuses on keeping the templates clean and readable, separating the logic from the markup. It serves a similar purpose but with a different philosophy and syntax.

README

pug-code-gen

Default code-generator for pug. It generates HTML via a JavaScript template function.

Installation

npm install pug-code-gen

Usage

var generateCode = require('pug-code-gen');

generateCode(ast, options)

Generate a JavaScript function string for the given AST.

ast is a fully expanded AST for Pug, with all inclusion, extends, and filters resolved.

options may contain the following properties that have the same meaning as the options with the same names in pug:

• pretty (boolean): default is false
• compileDebug (boolean): default is true
• doctype (string): default is undefined
• inlineRuntimeFunctions (boolean): default is false
• globals (array of strings): default is []
• self (boolean): default is false

In addition to above, pug-code-gen has the following unique options:

• includeSources (object): map of filename to source string; used if compileDebug is true; default is undefined
• templateName (string): the name of the generated function; default is 'template'

var lex = require('pug-lexer');
var parse = require('pug-parser');
var wrap = require('pug-runtime/wrap');
var generateCode = require('pug-code-gen');

var funcStr = generateCode(parse(lex('p Hello world!')), {
  compileDebug: false,
  pretty: true,
  inlineRuntimeFunctions: false,
  templateName: 'helloWorld'
});
//=> 'function helloWorld(locals) { ... }'

var func = wrap(funcStr, 'helloWorld');
func();
//=> '\n<p>Hello world!</p>'

new generateCode.CodeGenerator(ast, options)

The constructor for the internal class of the code generator. You shouldn't need to use this for most purposes.

License

MIT